Repository navigation
Replace CONTRIBUTING.md file with standard template - #282
Conversation
There was a problem hiding this comment.
Pull request overview
Replaces the repository-specific contribution guidelines with a short standard template that directs contributors to the centralized Progress Chef Workstation contributing documentation.
Changes:
- Removes the existing detailed
vscode-chefcontributing/development instructions. - Adds a standardized CONTRIBUTING header and a link to the Chef Workstation contribution guidelines site.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (1)
CONTRIBUTING.md:3
- The contribution-guidelines link appears to point to a non-existent page under
chef.github.io/chef-oss-practices(likely a 404). This will prevent contributors from finding the intended standard Chef Workstation contribution guide; please update it to a stable, existing URL (for example, the Chef Workstation repo’s CONTRIBUTING.md).
Thank you for your interest in contributing to this project! It is part of the larger Progress Chef Workstation project. Contribution guidelines can be found at [Contributing to Progress Chef Workstation](https://chef.github.io/chef-oss-practices/projects/workstation/contributing/).
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (2)
README.md:52
- Grammar: “Contributions are welcomed” is incorrect here; the standard phrasing is “Contributions are welcome”.
Contributions are welcomed! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
README.md:76
- This guideline is currently inaccurate as written:
package.jsoncontains a caret range (e.g.,engines.vscodeis^1.83.0). Consider scoping this rule to dependency version ranges (or explicitly excludingengines).
- **Exact versions only**: No `^` or `~` in `package.json`
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (2)
CONTRIBUTING.md:3
- The CONTRIBUTING.md link target appears to be incorrect/outdated (it may not resolve). If the intent is to redirect to the canonical Chef Workstation contribution guidelines, consider linking directly to the Chef Workstation repository’s CONTRIBUTING.md.
Thank you for your interest in contributing to this project! It is part of the larger Progress Chef Workstation project. Contribution guidelines can be found at [Contributing to Progress Chef Workstation](https://chef.github.io/chef-oss-practices/projects/workstation/contributing/).
README.md:52
- Grammar: “Contributions are welcomed” should be “Contributions are welcome”.
Contributions are welcomed! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (1)
README.md:80
npm run packageis configured to outputvscode-chef.vsix(see package.json scripts). The install command currently references./chef-<version>.vsix, which likely won’t exist and will mislead contributors.
code --install-extension ./chef-<version>.vsix
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (2)
README.md:84
npm run packageis configured to output a fixed filename (vscode-chef.vsix), socode --install-extension ./chef-<version>.vsixwill not work when following the Quick Reference as written. Update the install command to match the actual output produced by the package script.
code --install-extension ./chef-<version>.vsix
README.md:56
- This PR’s stated goal is to redirect contributors to the standard Chef Workstation contribution guidelines, but the README currently points to chef/chef’s CONTRIBUTING.md instead. This makes the README inconsistent with CONTRIBUTING.md and the PR description; please update the README link to the Workstation contribution page.
Contributions are welcomed! For general Chef contribution guidelines, including DCO requirements, PR process, and code review standards, see:
https://github.com/chef/chef/blob/master/CONTRIBUTING.md
- **Issues & Pull Requests**: [GitHub Issues](https://github.com/chef/vscode-chef/issues)
- **Community Slack**: [Chef Community](https://community-slack.chef.io/)
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (2)
README.md:82
- The Quick Reference install command points to
./chef-<version>.vsix, butnpm run packagerunsvsce package --out vscode-chef.vsix(see package.json scripts), so the produced filename won’t match this instruction.
```bash
CONTRIBUTING.md:3
- The CONTRIBUTING link appears to be broken/nonexistent; it should point to the Chef Workstation contribution guidelines you intend to reference (e.g., the chef/chef-workstation CONTRIBUTING.md).
Thank you for your interest in contributing to this project! It is part of the larger Progress Chef Workstation project. Contribution guidelines can be found at [Contributing to Progress Chef Workstation](https://chef.github.io/chef-oss-practices/projects/workstation/contributing/).
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (4)
README.md:164
- This section tells users to run
npx vsce package, but the repo already definesnpm run package(and forces--out vscode-chef.vsix). Usingnpx vsce packagewill produce a different output filename than the rest of this README now documents.
To produce a local .vsix for testing use `npx vsce package`:
```bash
npx vsce package
**README.md:73**
* The Quick Reference uses `npm run package`, which (per `package.json` scripts) outputs `vscode-chef.vsix`, but the install command references `./chef-<version>.vsix`. This will fail/confuse users when following the documented steps.
This issue also appears on line 160 of the same file.
Package for local testing
npm run package
Test locally
code --install-extension ./chef-.vsix
README.md:60
- The PR description says this change is a cherry-pick to replace/redirect
CONTRIBUTING.md, but this PR also adds substantial new build/PR-checklist documentation toREADME.md. Either update the PR description to reflect the README scope, or split the README changes into a separate PR to keep intent and review scope aligned.
### Quick Reference
README.md:170
vsceis a devDependency in this repo; asking contributors to runvsce publishassumes a global install. Also, the sentence "To release requires..." is grammatically incorrect. Prefernpx(ornpm exec) and a clearer sentence.
To release requires a PAT token for the relevant publisher on the Visual Studio Marketplace:
```bash
vsce publish
</details>
5da9d79 to
3a8e28a
Compare
3a8e28a to
a3d6640
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (3)
README.md:60
- The PR description says this change redirects contributors via a standard CONTRIBUTING template, but this PR also adds substantial contribution/build/checklist content into README. If intentional, the PR title/description should be updated to reflect the expanded scope (or the README changes split into a separate PR).
### Quick Reference
README.md:104
- The Community Slack link is listed both under “Contributions” and again under “Need Help?”. Consider keeping it in one place to avoid duplicated maintenance and potential drift if the URL/name changes.
- **Issues**: [GitHub Issues](https://github.com/chef/vscode-chef/issues)
- **Detailed build instructions**: See sections above
- **Chef Community**: [Community Slack](https://community-slack.chef.io/)
README.md:64
- The Quick Reference block says to always use
npm ciand notnpm install, but updating dependencies (and regeneratingpackage-lock.json) typically requiresnpm install. Consider rephrasing to keep the reproducible-build guidance without implyingnpm installis never used.
```bash
# Install dependencies (always use npm ci, not npm install)
npm ci
Signed-off-by: Nandan Hegde <220186393+nandanhegde73@users.noreply.github.com>
- Remove duplicate 'Install dependencies' section - Add Quick Reference section with all essential commands - Add Build Verification steps - Add Pull Request Checklist with DCO requirement - Add Need Help section with support links - Simplify Packaging/releasing section - Add Community Slack link to Contributions section - Fix typo: 'Command Pallette' -> 'Command Palette' - Update image URL from master to main branch - Use consistent bash code block formatting - Remove verbose output examples for cleaner documentation - Remove outdated CONTRIBUTING.md reference All essential build, test, and release commands preserved. Documentation is now cleaner, better organized, and more helpful. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: nikhil2611 <ngupta@progress.com>
a3d6640 to
c9aaf98
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (1)
README.md:73
- The Quick Reference suggests installing
./chef-<version>.vsixafter runningnpm run package, butnpm run packageis defined asvsce package --out vscode-chef.vsix(package.json:248). As written, the install command won’t match the file that gets produced.
# Package for local testing
npm run package
# Test locally
code --install-extension ./chef-<version>.vsix
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (1)
README.md:73
- The quick reference suggests installing
./chef-<version>.vsix, butnpm run packageis configured to outputvscode-chef.vsix(see package.json scripts). As written, the install command won’t match the generated artifact name.
# Package for local testing
npm run package
# Test locally
code --install-extension ./chef-<version>.vsix
Changed Copyright from h1 to h2 heading to match the formatting of other sections like Features, Installation, and Contributions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: nikhil2611 <ngupta@progress.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: nikhil2611 <ngupta@progress.com>
7a84e02 to
9df2577
Compare
Cherry-picked commit 4606172 to redirect contributors to the standard Chef Workstation contribution guidelines.